\section{NFcore::ComplexList Class Reference}
\label{classNFcore_1_1ComplexList}\index{NFcore::ComplexList@{NFcore::ComplexList}}
{\tt \#include $<$NFcore.hh$>$}



\subsection{Detailed Description}
Container to organize all system complexes. 

\begin{Desc}
\item[Author:]Justin Hogg \end{Desc}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf ComplexList} ()
\item 
{\bf $\sim$ComplexList} ()
\item 
bool {\bf isUsingComplex} () const 
\item 
void {\bf setUseComplex} (bool \_\-useComplex)
\item 
void {\bf setSystem} ({\bf System} $\ast$\_\-sys)
\item 
int {\bf createComplex} ({\bf Molecule} $\ast$m)
\item 
{\bf Complex} $\ast$ {\bf getComplex} (int ID\_\-complex) const 
\item 
{\bf Complex} $\ast$ {\bf getNextAvailableComplex} ()
\item 
void {\bf notifyThatComplexIsAvailable} (int ID\_\-complex)
\item 
void {\bf printAllComplexes} ()
\item 
void {\bf purgeAndPrintAvailableComplexList} ()
\item 
void {\bf outputComplexSizes} (double cSampleTime)
\item 
void {\bf outputMoleculeTypeCountPerComplex} ({\bf MoleculeType} $\ast$m)
\item 
double {\bf outputMeanCount} ({\bf MoleculeType} $\ast$m)
\item 
double {\bf calculateMeanCount} ({\bf MoleculeType} $\ast$m)
\item 
void {\bf resetComplexIter} ()
\item 
{\bf Complex} $\ast$ {\bf nextComplex} ()
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
vector$<$ {\bf Complex} $\ast$ $>$ {\bf allComplexes}
\item 
queue$<$ int $>$ {\bf nextAvailableComplex}
\item 
{\bf System} $\ast$ {\bf sys}
\item 
bool {\bf useComplex}
\end{CompactItemize}


\subsection{Constructor \& Destructor Documentation}
\index{NFcore::ComplexList@{NFcore::ComplexList}!ComplexList@{ComplexList}}
\index{ComplexList@{ComplexList}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ComplexList::ComplexList ()}\label{classNFcore_1_1ComplexList_7af5cdce42bafe57dd681c19100ddd4b}


\index{NFcore::ComplexList@{NFcore::ComplexList}!$\sim$ComplexList@{$\sim$ComplexList}}
\index{$\sim$ComplexList@{$\sim$ComplexList}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ComplexList::$\sim$ComplexList ()}\label{classNFcore_1_1ComplexList_00a16c47f49699657bc727dab354e1d3}




\subsection{Member Function Documentation}
\index{NFcore::ComplexList@{NFcore::ComplexList}!isUsingComplex@{isUsingComplex}}
\index{isUsingComplex@{isUsingComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool NFcore::ComplexList::isUsingComplex () const\hspace{0.3cm}{\tt  [inline]}}\label{classNFcore_1_1ComplexList_305333d3f840793251d8e3c38be2c3a7}


\index{NFcore::ComplexList@{NFcore::ComplexList}!setUseComplex@{setUseComplex}}
\index{setUseComplex@{setUseComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NFcore::ComplexList::setUseComplex (bool {\em \_\-useComplex})\hspace{0.3cm}{\tt  [inline]}}\label{classNFcore_1_1ComplexList_e75a2b55f6f910eb942d6b42953c2a82}


\index{NFcore::ComplexList@{NFcore::ComplexList}!setSystem@{setSystem}}
\index{setSystem@{setSystem}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NFcore::ComplexList::setSystem ({\bf System} $\ast$ {\em \_\-sys})\hspace{0.3cm}{\tt  [inline]}}\label{classNFcore_1_1ComplexList_cc5550dd0eb8868efecfcffc1f4f097d}


\index{NFcore::ComplexList@{NFcore::ComplexList}!createComplex@{createComplex}}
\index{createComplex@{createComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int ComplexList::createComplex ({\bf Molecule} $\ast$ {\em m})}\label{classNFcore_1_1ComplexList_e0da5617d8cc2336feb97118979677e2}


\index{NFcore::ComplexList@{NFcore::ComplexList}!getComplex@{getComplex}}
\index{getComplex@{getComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Complex}$\ast$ NFcore::ComplexList::getComplex (int {\em ID\_\-complex}) const\hspace{0.3cm}{\tt  [inline]}}\label{classNFcore_1_1ComplexList_06ee8909fcd6e18ccde92f282058bafd}


\index{NFcore::ComplexList@{NFcore::ComplexList}!getNextAvailableComplex@{getNextAvailableComplex}}
\index{getNextAvailableComplex@{getNextAvailableComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Complex} $\ast$ ComplexList::getNextAvailableComplex ()}\label{classNFcore_1_1ComplexList_bb6812b53c88ea10f790a6222e9f97d7}


\index{NFcore::ComplexList@{NFcore::ComplexList}!notifyThatComplexIsAvailable@{notifyThatComplexIsAvailable}}
\index{notifyThatComplexIsAvailable@{notifyThatComplexIsAvailable}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ComplexList::notifyThatComplexIsAvailable (int {\em ID\_\-complex})}\label{classNFcore_1_1ComplexList_a6288a16e2741bd0f80ea8ace6f5a177}


\index{NFcore::ComplexList@{NFcore::ComplexList}!printAllComplexes@{printAllComplexes}}
\index{printAllComplexes@{printAllComplexes}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ComplexList::printAllComplexes ()}\label{classNFcore_1_1ComplexList_c3c814d045e547b93e1d4346a5edd8c5}


\index{NFcore::ComplexList@{NFcore::ComplexList}!purgeAndPrintAvailableComplexList@{purgeAndPrintAvailableComplexList}}
\index{purgeAndPrintAvailableComplexList@{purgeAndPrintAvailableComplexList}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ComplexList::purgeAndPrintAvailableComplexList ()}\label{classNFcore_1_1ComplexList_2a54f17de9fb937f592b9b17b1fa02f3}


\index{NFcore::ComplexList@{NFcore::ComplexList}!outputComplexSizes@{outputComplexSizes}}
\index{outputComplexSizes@{outputComplexSizes}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ComplexList::outputComplexSizes (double {\em cSampleTime})}\label{classNFcore_1_1ComplexList_4a7b38fd2ed89b8421bdbb409fa67cf9}


\index{NFcore::ComplexList@{NFcore::ComplexList}!outputMoleculeTypeCountPerComplex@{outputMoleculeTypeCountPerComplex}}
\index{outputMoleculeTypeCountPerComplex@{outputMoleculeTypeCountPerComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ComplexList::outputMoleculeTypeCountPerComplex ({\bf MoleculeType} $\ast$ {\em m})}\label{classNFcore_1_1ComplexList_ee6b90e3791023ad904c5a0d1b0db80b}


\index{NFcore::ComplexList@{NFcore::ComplexList}!outputMeanCount@{outputMeanCount}}
\index{outputMeanCount@{outputMeanCount}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}double ComplexList::outputMeanCount ({\bf MoleculeType} $\ast$ {\em m})}\label{classNFcore_1_1ComplexList_b3e356f3e4c06cc17dec65061d232e68}


\index{NFcore::ComplexList@{NFcore::ComplexList}!calculateMeanCount@{calculateMeanCount}}
\index{calculateMeanCount@{calculateMeanCount}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}double ComplexList::calculateMeanCount ({\bf MoleculeType} $\ast$ {\em m})}\label{classNFcore_1_1ComplexList_3031743a6abd72af345e2c2175881985}


\index{NFcore::ComplexList@{NFcore::ComplexList}!resetComplexIter@{resetComplexIter}}
\index{resetComplexIter@{resetComplexIter}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NFcore::ComplexList::resetComplexIter ()\hspace{0.3cm}{\tt  [inline]}}\label{classNFcore_1_1ComplexList_7d2778546e52813c8202f5e6f1553969}


\index{NFcore::ComplexList@{NFcore::ComplexList}!nextComplex@{nextComplex}}
\index{nextComplex@{nextComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Complex}$\ast$ NFcore::ComplexList::nextComplex ()\hspace{0.3cm}{\tt  [inline]}}\label{classNFcore_1_1ComplexList_a09913bd2d0a8fe1005c93d38941ab0a}




\subsection{Member Data Documentation}
\index{NFcore::ComplexList@{NFcore::ComplexList}!allComplexes@{allComplexes}}
\index{allComplexes@{allComplexes}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}vector$<${\bf Complex} $\ast$ $>$ {\bf NFcore::ComplexList::allComplexes}\hspace{0.3cm}{\tt  [protected]}}\label{classNFcore_1_1ComplexList_146d4a4db088fb6c70c67e3c9dca62ae}


container of all complexes in the simulation \index{NFcore::ComplexList@{NFcore::ComplexList}!nextAvailableComplex@{nextAvailableComplex}}
\index{nextAvailableComplex@{nextAvailableComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}queue$<$int$>$ {\bf NFcore::ComplexList::nextAvailableComplex}\hspace{0.3cm}{\tt  [protected]}}\label{classNFcore_1_1ComplexList_981bea128eeea140b44ad1b28b50784a}


queue tells us which complexes can be used next \index{NFcore::ComplexList@{NFcore::ComplexList}!sys@{sys}}
\index{sys@{sys}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf System}$\ast$ {\bf NFcore::ComplexList::sys}\hspace{0.3cm}{\tt  [protected]}}\label{classNFcore_1_1ComplexList_465b362ba62263c15c43973af283ccad}


\index{NFcore::ComplexList@{NFcore::ComplexList}!useComplex@{useComplex}}
\index{useComplex@{useComplex}!NFcore::ComplexList@{NFcore::ComplexList}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool {\bf NFcore::ComplexList::useComplex}\hspace{0.3cm}{\tt  [protected]}}\label{classNFcore_1_1ComplexList_9392048fb2f9210ed5ee8161f667f467}




The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
/home/msneddon/eclipse/indigo/workspace/NFsim/src/NFcore/{\bf NFcore.hh}\item 
/home/msneddon/eclipse/indigo/workspace/NFsim/src/NFcore/{\bf complexList.cpp}\end{CompactItemize}
